Generalise configuration-setting substitution across the guides - #993
Merged
Conversation
Substitution parameters apply to all configuration settings, not only those defined in configuration files. In the Unix guide, move the References to other Configuration Parameters section up from the configuration files page to the general configuration parameters page. In the Windows guide, note the pre-defined [=DOCUMENTS] substitution. Part of Dyalog#988.
DyalogRichard
requested changes
Aug 10, 2026
DyalogRichard
requested changes
Aug 10, 2026
All configuration parameters are string values, so the qualifier is redundant; strike it in both the Unix and Windows guides, per review.
Per review, the relocation of References to other Configuration Parameters is pertinent to Windows too: move it from the configuration files page up to the general configuration parameters page, matching the Unix guide, since substitution applies to all configuration settings regardless of how they are defined.
Contributor
|
I'm afraid it is getting very hard in GitHub to see what is what now. However, I have noticed one important error in the move of the description of [XXX] substitution from config files to configuration settings in general: the [.] substitution (which expands to the config file directory) is still relevant to config files only - it would be meaningless anywhere else. So that bit needs moving back. Perhaps when this is done, a rendered copy of the changed documents could be supplied? |
Collaborator
|
@DyalogRichard you can see the clean state passably rendered by GitHub on the PR branch. |
DyalogRichard
previously requested changes
Aug 25, 2026
The substitution feature is now general, so drop the redundant '(regardless/ irrespective of where they are defined)' qualifier on both the Windows and UNIX pages. The '[.]' current-directory reference applies to configuration files only, so move it out of the general configuration-parameters page and back into the Windows configuration-files page under its own heading, cross-referenced to the general references section.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Substitution parameters apply to all configuration settings, not only those defined in configuration files. In the Unix guide, move the References to other Configuration Parameters section up from the configuration files page to the general configuration parameters page. In the Windows guide, note the pre-defined [=DOCUMENTS] substitution.
Fixes #988.